package com.gksc.video;

import lombok.extern.slf4j.Slf4j;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * @ClassName: Swagger2
 * @Description: Swagger启动类, 启动后，可以通过http://localhost:port/swagger-ui.html来访问API
 * @author: liao.yx
 * @date: 2019年5月7日 下午8:19:23
 * @copyRight: 2020 liao.yx All rights reserved.
 */
@Slf4j
@Configuration
public class Swagger2 {

    /**
     * @throws
     * @Title: createRestApi
     * @Description: swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
     * @param: @return
     * @return: Docket
     */
    @Bean
    public Docket createRestApi() {
        log.info("Swagger2 for VideoApp started, createRestApi!");
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //为当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.gksc.video.controller")) //这个包指的是我们在哪些类中使用swagger2来测试。
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * @throws
     * @Title: apiInfo
     * @Description: 构建 api文档的详细信息函数,注意这里的注解引用的是哪个)
     * @param: @return
     * @return: ApiInfo
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("Api of gkzf VideoApp")
                //创建人
                .contact(new Contact("idme", "http://www.learn.com.cn", "1229053515@qq.com"))
                //版本号
                .version("1.0")
                //描述
                .description("VideoApp Api")
                .build();
    }
}
